all files / cds/record/ module.js

100% Statements 52/52
100% Branches 11/11
100% Functions 19/19
100% Lines 52/52
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281                                                                                                                                                                                                                                                                                                                                                                                                                                                                         
/*
 * This file is part of CERN Document Server.
 * Copyright (C) 2016 CERN.
 *
 * CERN Document Server is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * CERN Document Server is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with CERN Document Server; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 *
 * In applying this license, CERN does not
 * waive the privileges and immunities granted to it by virtue of its status
 * as an Intergovernmental Organization or submit itself to any jurisdiction.
 */
(function (angular, $http) {
  // Controllers
 
  /**
    * @ngdoc controller
    * @name cdsRecordController
    * @namespace cdsRecordController
    * @description
    *    CDS record controller.
    */
  function cdsRecordController($scope, $sce, $http) {
 
    // Parameters
 
    // Assign the controller to `vm`
    var vm = this;
 
    // Record Loading - If the cdsRecord has the state loading
    vm.cdsRecordLoading = true;
 
    // Record Error - if the cdsRecord has any error
    vm.cdsRecordError = null;
 
    // Record Warn - if the cdsRecord has any warning
    vm.cdsRecordWarning = null;
 
    ////////////
 
    // Functions
 
    /**
      * Trust iframe url
      * @memberof cdsRecordController
      * @function cdsRecordIframe
      * @param {String} url - The url.
      */
    function cdsRecordIframe(url) {
      // Return the trusted url
      return $sce.trustAsResourceUrl(url);
    }
 
    /**
      * When the module initialized
      * @memberof cdsRecordController
      * @function cdsRecordInit
      * @param {Object} evt - The event object.
      */
    function cdsRecordInit(evt) {
      // Stop loading
      vm.cdsRecordLoading = false;
    }
 
    /**
      * Change the state to loading
      * @memberof cdsRecordController
      * @function cdsRecordLoadingStart
      * @param {Object} evt - The event object.
      */
    function cdsRecordLoadingStart(evt) {
      // Set the state to loading
      vm.cdsRecordLoading = true;
    }
 
    /**
      * Change the state to normal
      * @memberof cdsRecordController
      * @function cdsRecordLoadingStop
      * @param {Object} evt - The event object.
      */
    function cdsRecordLoadingStop(evt) {
      // Set the state to normal
      vm.cdsRecordLoading = false;
    }
 
    /**
      * Show error messages
      * @memberof cdsRecordController
      * @function cdsRecordError
      * @param {Object} evt - The event object.
      * @param {Object} error - The object with the errors.
      */
    function cdsRecordError(evt, error) {
      // Reset the error
      vm.cdsRecordError = null;
      // Attach the error to the scope
      vm.cdsRecordError = error;
    }
 
    /**
      * Show warning messages
      * @memberof cdsRecordController
      * @function cdsRecordWarn
      * @param {Object} evt - The event object.
      * @param {Object} warning - The object with the warnings.
      */
    function cdsRecordWarn(evt, warning) {
      // Reset the error
      vm.cdsRecordWarning = null;
      // Attach the warning to the scope
      vm.cdsRecordWarning = warning;
    }
 
    $scope.logMediaDownload = function (fileObj) {
      if (!$scope.mediaDownloadEventUrl) {
        return;
      }
 
      var quality = fileObj.context_type === 'master' ? 'master' : fileObj.tags.preset_quality,
          replacedUrl = replaceMediaDownloadUrlParams(
            $scope.mediaDownloadEventUrl,
            $scope.record.metadata,
            fileObj.key,
            quality
          );
 
        $http.get(replacedUrl)
        .then(function(response) {
        })
        .then(function(error) {
        });
    };
 
    function replaceMediaDownloadUrlParams(url, recordMetadata, filename, quality) {
      var reportNumber = recordMetadata.hasOwnProperty('report_number') &&
            recordMetadata.report_number instanceof Array &&
            recordMetadata.report_number.length > 0 ? recordMetadata.report_number[0] : '',
          filenameParts = filename.split('.'),
          filenamePartsCount = filenameParts.length,
          fileFormat = filenamePartsCount > 1 ? filenameParts[filenamePartsCount - 1] : '';
 
      return url
        .replace('{recid}', recordMetadata.recid)
        .replace('{report_number}', reportNumber)
        .replace('{format}', fileFormat)
        .replace('{quality}', quality);
    }
 
    ////////////
 
    // Assignements
 
    // Iframe src
    vm.iframeSrc = cdsRecordIframe;
 
    ////////////
 
    // Listeners
 
    // When the module initialized
    $scope.$on('cds.record.init', cdsRecordInit);
 
    // When there is an error
    $scope.$on('cds.record.error', cdsRecordError);
    // When there is a warning
    $scope.$on('cds.record.warn', cdsRecordWarn);
 
    // When loading requested to start
    $scope.$on('cds.record.loading.start', cdsRecordLoadingStart);
    // When loading requested to stop
    $scope.$on('cds.record.loading.stop', cdsRecordLoadingStop);
  }
 
  cdsRecordController.$inject = ['$scope', '$sce', '$http'];
 
  ////////////
 
  // Directives
 
  /**
    * @ngdoc directive
    * @name cdsRecordView
    * @description
    *    The cdsRecordView directive
    * @namespace cdsRecordView
    * @example
    *    Usage:
    *    <cds-record-view
    *     template='TEMPLATE_PATH'>
    *    </cds-record-view>
    */
  function cdsRecordView($http) {
 
    // Functions
 
    /**
      * Force apply the attributes to the scope
      * @memberof cdsRecordView
      * @param {service} scope -  The scope of this element.
      * @param {service} element - Element that this direcive is assigned to.
      * @param {service} attrs - Attribute of this element.
      * @param {cdsRecordCtrl} vm - CERN Document Server record controller.
      */
      function link(scope, element, attrs, vm) {
        scope.mediaDownloadEventUrl = attrs.mediaDownloadEventUrl;
 
        // Get the record object and make it available to the scope
        $http.get(attrs.record)
          .then(function(response) {
            scope.record = response.data;
            scope.$broadcast('cds.record.init');
          }, function(error) {
            scope.$broadcast('cds.record.error', error);
          });
 
        // Get the number of views for the record and make it available to the scope
        $http.get(attrs.recordViews)
          .then(function(response) {
            scope.recordViews = response.data;
          }, function(error) {
            scope.$broadcast('cds.record.error', error);
          });
      }
 
    /**
      * Choose template for search bar
      * @memberof cdsRecordView
      * @param {service} element - Element that this direcive is assigned to.
      * @param {service} attrs - Attribute of this element.
      * @example
      *    Minimal template `template.html` usage
      *    {{ record.title_statement.title }}
      */
    function templateUrl(element, attrs) {
      return attrs.template;
    }
 
    ////////////
 
    return {
      restrict: 'AE',
      scope: false,
      controller: 'cdsRecordCtrl',
      controllerAs: 'vm',
      link: link,
      templateUrl: templateUrl,
    };
  }
 
  cdsRecordView.$inject = ['$http'];
 
  ////////////
 
  // Setup everything
 
  angular.module('cdsRecord.directives', [])
    .directive('cdsRecordView', cdsRecordView);
 
  angular.module('cdsRecord.controllers', [])
    .controller('cdsRecordCtrl', cdsRecordController);
 
  angular.module('cdsRecord', [
    'cdsRecord.controllers',
    'cdsRecord.directives'
  ]);
 
  //////////// HAPPY CDS Devs :)
 
})(angular);